////////////////////////////////////////////////////////////////////////////////////////////////////
/// Copyright (c) 2009 - 2010 RacoonStudios
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this
/// software and associated documentation files (the "Software"), to deal in the Software
/// without restriction, including without limitation the rights to use, copy, modify, merge,
/// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
/// to whom the Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all copies or
/// substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
/// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS IN THE SOFTWARE.
////////////////////////////////////////////////////////////////////////////////////////////////////

#pragma once
#ifndef win32heap_h__
#define win32heap_h__

#include "core/types.h"

namespace Win32
{
	////////////////////////////////////////////////////////////////////////////////////////////////////
	/// \class	Win32Heap
	///
	/// \brief	Window 32 heap. 
	///
	/// \author	Markus
	/// \date	21.02.2010
	////////////////////////////////////////////////////////////////////////////////////////////////////
	class Win32Heap
	{
	public:

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	static void Setup()
		///
		/// \brief	Setups this object. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		static void Setup();

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	Win32Heap(const char * name, size_t initSize = 0, size_t maxSize = 0)
		///
		/// \brief	Constructor. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param	name		The name. 
		/// \param	initSize	Size of the initialise. 
		/// \param	maxSize		Size of the maximum. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		Win32Heap(const char * name, size_t initSize = 0, size_t maxSize = 0);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	~Win32Heap()
		///
		/// \brief	Finaliser. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		~Win32Heap();




		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	const char * GetName() const
		///
		/// \brief	Gets the name. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \return	null if it fails, else the name. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		const char * GetName() const;

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	void * Alloc(size_t size)
		///
		/// \brief	Allocs. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param	size	The size. 
		///
		/// \return	null if it fails, else. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		void * Alloc(size_t size);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	void * Realloc(void * ptr, size_t size)
		///
		/// \brief	Reallocs. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	ptr	If non-null, the pointer. 
		/// \param	size		The size. 
		///
		/// \return	null if it fails, else. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		void * Realloc(void * ptr, size_t size);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	void Free(void * ptr)
		///
		/// \brief	Frees. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	ptr	If non-null, the pointer. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		void Free(void * ptr);

	protected:

	private:

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	Win32Heap()
		///
		/// \brief	Default constructor. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		////////////////////////////////////////////////////////////////////////////////////////////////////
		Win32Heap();

		HANDLE m_heap;

		const char * m_name;

	};

}

#endif // win32heap_h__